Skip to main content
GET
/
v2
/
subscriptions
/
transitions
List subscription transitions
curl --request GET \
  --url https://api.hyperline.co/v2/subscriptions/transitions \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.hyperline.co/v2/subscriptions/transitions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hyperline.co/v2/subscriptions/transitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperline.co/v2/subscriptions/transitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.hyperline.co/v2/subscriptions/transitions"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.hyperline.co/v2/subscriptions/transitions")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v2/subscriptions/transitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "base_subscription_id": "<string>",
      "source_subscription_id": "<string>",
      "target_subscription_id": "<string>",
      "transitioned_at": "2023-12-25",
      "name": "<string>",
      "transition_date": "2023-12-25"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0
status
Available options:
scheduled,
draft,
completed,
cancelled,
failed,
pending_quote_signature
status__in
Available options:
scheduled,
draft,
completed,
cancelled,
failed,
pending_quote_signature
source_subscription_id
string
source_subscription_id__not
string
source_subscription_id__isNull
string
source_subscription_id__isNotNull
string
source_subscription_id__equals
string
source_subscription_id__contains
string
source_subscription_id__startsWith
string
source_subscription_id__endWith
string
base_subscription_id
string
base_subscription_id__not
string
base_subscription_id__isNull
string
base_subscription_id__isNotNull
string
base_subscription_id__equals
string
base_subscription_id__contains
string
base_subscription_id__startsWith
string
base_subscription_id__endWith
string
target_subscription_id
string
target_subscription_id__not
string
target_subscription_id__isNull
string
target_subscription_id__isNotNull
string
target_subscription_id__equals
string
target_subscription_id__contains
string
target_subscription_id__startsWith
string
target_subscription_id__endWith
string
transition_date
string<date-time>
transition_date__not
string<date-time>
transition_date__isNull
string<date-time>
transition_date__isNotNull
string<date-time>
transition_date__equals
string<date-time>
transition_date__lt
string<date-time>
transition_date__lte
string<date-time>
transition_date__gt
string<date-time>
transition_date__gte
string<date-time>
transitioned_at
string<date-time>
transitioned_at__not
string<date-time>
transitioned_at__isNull
string<date-time>
transitioned_at__isNotNull
string<date-time>
transitioned_at__equals
string<date-time>
transitioned_at__lt
string<date-time>
transitioned_at__lte
string<date-time>
transitioned_at__gt
string<date-time>
transitioned_at__gte
string<date-time>

Response

200 - application/json
meta
object
required
data
object[]
required

List of SubscriptionTransition.